本类用于分享设备给指定用户,用户接受分享后,可以同样获得对设备的控制权限。
一、注意事项
无
二、属性列表
| 参数名称 | 描述 | 类型 |
|---|---|---|
| device | 要分享的设备 | XDevice |
| account | 接收分享者账号(邮箱或者手机号) | NSString |
| sourceType | 用户来源,第三方来源用户需要填 | XLinkUserSourceType |
| shareDeviceMode | 分享的方式 | XLinkShareDeviceMode |
| expired | 过期时间(单位秒) | NSString |
| authority | 对设备的控制权限,R可读,W可写,RW可读可写;默认为null相当于RW | NSString |
- XLinkShareDeviceMode 枚举值说明
| 值 | 描述 |
|---|---|
| XLinkShareDeviceModeApp | 通过账号分享 |
| XLinkShareDeviceModeQrcode | 通过二维码分享 |
| XLinkShareDeviceModeEmail | 通过发送邮件分享 |
三、API 列表
1. 构建通过账号分享设备任务
+ (instancetype)shareDeviceTaskWithDevice:(XDevice *)device
account:(NSString *)account
expired:(NSString *)expired
shareMode:(XLinkShareDeviceMode)shareDeviceMode
authority:(NSString *)authority
timeout:(NSUInteger)timeout
completionHandler:(XLinkTaskDidCompletionHandler)completionHandler;
支持的版本
开始支持的版本:6.1
注意事项
无
输入参数
具体的接口输入参数描述如下:
| 参数名称 | 类型 | 描述 | 必选 |
|---|---|---|---|
| device | XDevice | 要分享的设备 | 是 |
| account | NSString | 接收分享者账号(邮箱或者手机号) | |
| sourceType | XLinkUserSourceType | 用户来源,第三方来源用户需要填 | 是 |
| shareDeviceMode | XLinkShareDeviceMode | 分享的方式 | 是 |
| expired | NSString | 过期时间(单位秒) | 是 |
| authority | NSString | 对设备的控制权限,R可读,W可写,RW可读可写;默认为null相当于RW | 是 |
| timeout | NSUInteger | 任务超时时间 | 是 |
| completionHandler | XLinkTaskDidCompletionHandler | 完成后的回调 | 是 |
输出参数
无
错误码
无
2. 构建通过账号分享设备任务
+ (instancetype)shareDeviceTaskWithDevice:(XDevice *)device
openId:(NSString *)openId
sourceType:(XLinkUserSourceType)sourceType
expired:(NSString *)expired
shareMode:(XLinkShareDeviceMode)shareDeviceMode
authority:(NSString *)authority
timeout:(NSUInteger)timeout
completionHandler:(XLinkTaskDidCompletionHandler)completionHandler;
支持的版本
开始支持的版本:6.1
注意事项
无
输入参数
具体的接口输入参数描述如下:
| 参数名称 | 类型 | 描述 | 必选 |
|---|---|---|---|
| device | XDevice | 要分享的设备 | 是 |
| openId | NSString | 对方openId | |
| sourceType | XLinkUserSourceType | 用户来源,第三方来源用户需要填 | 是 |
| shareDeviceMode | XLinkShareDeviceMode | 分享的方式 | 是 |
| expired | NSString | 过期时间(单位秒) | 是 |
| authority | NSString | 对设备的控制权限,R可读,W可写,RW可读可写;默认为null相当于RW | 是 |
| timeout | NSUInteger | 任务超时时间 | 是 |
| completionHandler | XLinkTaskDidCompletionHandler | 完成后的回调 | 是 |
输出参数
无
错误码
无
